home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / misc / xpkMASH_r2.readme < prev    next >
Text File  |  1995-02-12  |  6KB  |  151 lines
  1. Short:    XpkMASH.library another LZ77 library
  2. Author:   Zdenek Kabelac (kabi@fi.muni.cz)
  3. Uploader: Zdenek Kabelac (kabi@fi.muni.cz)
  4. Type:     util/misc
  5.  
  6.                     MASH
  7.            Another LZRW based compression algorithm
  8.             Version 1.26 (10 Dec 1994)
  9.              Copyright 1994 Zdenek Kabelac
  10.  
  11.                                 License/Disclaimer
  12.                                 ------------------
  13.     xpkMASH is (C) Copyright 1994 by Zdenek Kabelac.
  14.  
  15.     This package may be freely distributed, as long as it is kept in its
  16. original, complete, and unmodified form.  It may not be distributed by itself
  17. or in a commercial package of any kind without my written permission.
  18.  
  19.     xpkMASH is distributed in the hope that it will be useful, but WITHOUT ANY
  20. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  21. PARTICULAR PURPOSE.
  22.  
  23.  
  24.                 Installation
  25.                 ------------
  26.  
  27.     Make sure the directory libs:compressors does exist and then just copy
  28. xpkFAST.library to libs:compressors.  You also need to have the XPK package
  29. installed, it is available from several sources including Fish disks.
  30.  
  31.  
  32.                  Description
  33.                  -----------
  34.  
  35.     xpkMASH is an XPK compression sublibrary whose main purpose is to be fast
  36. in decrunch and have excelent crunch factor.  The sublib is using LZ77
  37. compression, but uses special method in writing matches...  Also have very nice
  38. feature - hashing uses a lot of memory - 128KB, but when the memory is low it
  39. will reduce size down upto 4KB, but it will be very very slow.  Buffer size is
  40. 32KB.  Default chunk size is 64KB.  Decompresion is very very fast.  Also uses
  41. lazy eval method in searching matches - look in the source if you'd like to
  42. know what this means, also if you want to know more about this program - it
  43. slowed everything down, but only in compression.
  44.    Sublibrary has several modes:
  45.  
  46.         Mode          Strings to be searched
  47.        ------        ------------------------
  48.  
  49.          0- 9        1       ;for OnTheFly compres (but rake is better)
  50.         10-19        2       ;fast but not excelent CF
  51.         20-29        4
  52.         30-39        8
  53.         40-49        16
  54.         50-59        32      ;good speed, good results
  55.         60-69        64
  56.         70-79        128
  57.         80-89        256     ;usualy good enough
  58.         90-99        512
  59.         100          1024    ;the best, the slowest
  60.  
  61. The second colums shows how many matches should be compared
  62. - the more searched strings - the better results you will get
  63.  
  64. Last words: I've been using this version 1.16 for two months and no errors
  65.             has occured.
  66.             And if you want to improve it - send me copy of your work.
  67.  
  68.             Source fot this version is not released, if you want this
  69.             send me an e-mail
  70.  
  71.         I'll do some improvements later, but for now I don't have time.
  72.         Decompression is OK, but compression is ugly slow, so look
  73.         forward for faster compression.
  74.  
  75.  
  76. Here is benchmark result:
  77. Evaluated on a A3000/30/25 with 2MB ChipMem and 4MB SCRAM [standard
  78. XPK benchmark system] by XBench using AmigaVision [594712 bytes]
  79. executable as data.
  80.  
  81. mash.000   594712 332652 44.1%      8.59   69233      1.47  404565
  82. mash.010   594712 329784 44.6%      9.04   65786      1.46  407336
  83. mash.020   594712 326056 45.2%      9.75   60996      1.46  407336
  84. mash.030   594712 322496 45.8%     10.93   54410      1.44  412994
  85. mash.040   594712 319540 46.3%     12.75   46644      1.44  412994
  86. mash.050   594712 317128 46.7%     15.60   38122      1.43  415882
  87. mash.060   594712 315572 47.0%     19.91   29870      1.42  418811
  88. mash.070   594712 314684 47.1%     26.02   22855      1.42  418811
  89. mash.080   594712 314324 47.2%     33.75   17621      1.42  418811
  90. mash.090   594712 314096 47.2%     45.13   13177      1.42  418811
  91. mash.100   594712 313908 47.3%     65.42    9090      1.42  418811
  92.  
  93.  
  94.  
  95.  
  96.                    History
  97.                    -------
  98.  unreleased
  99.  V0.5    Many errors, the biggest problem was bad writing of bits string.
  100.  
  101.  V0.7    Most of errors has been debuged
  102.  
  103.  V0.8   Last byte has not been saved
  104.  
  105.  V0.9   On the first look normaly working version of the sublibrary with
  106.         fixed hash table - size 64KB
  107.  
  108.  V1.0   The big improvement in memory allocating
  109.     memory is allocated before each chunk compresion and deallocated
  110.         after this chunk is compressed (usefull if you have installed
  111.         statram.device)
  112.  
  113.  V1.01  Hash size was increased from 64KB to 128KB (16 bits)
  114.  
  115.  V1.05  Hash is allocated dynamicaly - when is large memory free - large hash
  116.         is used. Starting with 128KB, 64KB, 32KB, .... ,512 bytes
  117.  
  118.  V1.15  Seems to work perfectly for me
  119.  
  120.  V1.16  I suppose last bug has been removed - value of register D4
  121.         was not saved on return. Also most of long word instruction has
  122.         been rewritten to word oriented instructions (useful for MC68000)
  123.  
  124.  first public release:
  125.  
  126.  
  127.  V1.26  Several speed up improvements - decompression goes about 50 kB faster
  128.  
  129.  
  130.  
  131.  
  132.                                 Contact Address
  133.                                 ---------------
  134.  
  135.         Zdenek Kabelac
  136.         Policna 135
  137.         Valasske Mezirici
  138.         757 01 Czech republic
  139.  
  140.         "kabi/informatics.muni.cz"
  141.  
  142.  
  143. ============================= Archive contents =============================
  144.  
  145. Original  Packed Ratio    Date     Time    Name
  146. -------- ------- ----- --------- --------  -------------
  147.     5000    2302 53.9% 16-Dec-94 11:20:16  xpkMASH/xpkMASH.doc
  148.     2044    1472 27.9% 16-Dec-94 10:56:48  xpkMASH/xpkMASH.library
  149. -------- ------- ----- --------- --------
  150.     7044    3774 46.4% 16-Dec-94 12:14:08   2 files
  151.